URL
https://esb-test.lla.com/tmf-api/prepayBalanceManagement/v4/{businessId}/topupBalance
URL PARAMS
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| name | value | description | required |
|---|
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
| name | value | description | required |
|---|
| client_id | string | Public identifier to the application o channel | Y |
| client_secret | string | Is a secret known only to the application and the authorization server | Y |
Body
TopUpBalance-JM-BTC-Request:
{
"voucher": "89742282598199",
"amount": {
"amount": 1,
"units": "JMD"
},
"partyAccount": {
"id": "18763187057",
"@type": "subscriberNumber"
},
"bucket": {
"id": "1",
"href": "https://esb-dev.lla.com/prepayBalanceManagement/v4/bucket/1",
"description": "Primary Balance",
"name": "Primary Balance",
"@baseType": "BucketBalance",
"@type": "Core"
}
}
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 201 ]
Created- createTopupBalance request processed successfully, response body contains an entity corresponding to the requested resource
JM-Limeware- Response:
{
"description": "primaryBalance",
"voucher": "7539589136725",
"amount": {
"amount": 5.00,
"units": "JMD"
},
"bucket": {
"id": "1",
"href": "https://esb-dev.lla.com/prepayBalanceManagement/v4/bucket/1",
"description": "primaryBalance",
"name": "primaryBalance",
"@baseType": "BucketBalance",
"@type": "Core",
"usageType": "currency",
"remainingValue": {
"amount": 8.00,
"units": "JMD"
},
"remainingValueName": "primaryBalance",
"validFor": {
"endDateTime": "2022-03-01T00:00:00.000-05:00"
}
},
"ImpactedBucket": [
{
"amountAfter": {
"amount": 25.59,
"units": "JMD"
},
"amountBefore": {
"amount": 22.59,
"units": "JMD"
},
"name": "Primary Balance",
"@type": "Core"
},
{
"amountAfter": {
"amount": 0.00,
"units": "JMD"
},
"amountBefore": {
"amount": 2.00,
"units": "JMD"
},
"name": "Loan Balance",
"@type": "Loan"
},
]
}
PA Prepaid Topup balance Voucherless Response
{
"id": "04042023-0000-0000-0000-000000000303",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement-ux/v4/PA/topupBalance",
"bucket": {
"id": "69823571",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement-ux/v4/PA/bucket/69823571"
},
"ImpactedBucket": [
{
"amountAfter": {
"amount": 2.0,
"units": "USD"
}
},
{
"amountBefore": {
"amount": 7.0,
"units": "USD"
}
}
],
"amount":{
"amount": 4.0,
"units": "USD"
},
"status": "Successful",
"reason": "The customer topped up with 4 USD",
"validFor": {
"startDateTime": "2023-10-20T06:56:59-05:00"
},
"channel": {
"id": "PG-WEB-YappyTst",
"href": "PG-WEB-YappyTst",
"name": "PG-WEB-YappyTst"
},
"requestedDate": "2023-10-20T06:56:59-05:00"
}
PA Prepaid Topup balance Voucher Response
{
"id": "04042023-0000-0000-0000-000000000207",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement-ux/v4/PA/topupBalance",
"bucket": {
"id": "69877226",
"href": "https://esb-test.lla.com/tmf-api/prepayBalanceManagement-ux/v4/PA/bucket/69877226"
},
"ImpactedBucket": [
{
"amountAfter": {
"amount": 2.0,
"units": "USD"
}
},
{
"amountBefore": {
"amount": 7.0,
"units": "USD"
}
}
],
"amount":{
"amount": 0.0,
"units": "USD"
},
"status": "Successful",
"reason": "The customer topped up with voucher code",
"validFor": {
"startDateTime": "2023-10-16T01:43:47-05:00"
},
"channel": {
"id": "PG-WEB-YappyTst",
"href": "PG-WEB-YappyTst",
"name": "PG-WEB-YappyTst"
},
"requestedDate": "2023-10-16T01:43:46-05:00"
}